Get Membership Contact List GET
Obtains the list of contacts associated with a specific LEAF charity membership
Response Parameters
| Parameter | Name | Type | Description |
| contacts | Contacts | List (Optional) | The list of users that are contacts for this membership |
UserGUID
| User Entity GUID | String (Optional) | The entity GUID of the user |
Name
| Name | String (Optional) | The name of the user |
UserName
| User Name | String (Optional) | The username of the user |
EmailAddress
| Email Address | String (Optional) | The email address of the user |
IsPrimaryContact
| Is Primary Contact | Boolean (Optional) | Specifies whether the user is the primary contact of this membership |
IsBillingContact
| Is Secondary Contact | Boolean (Optional) | Specifies whether the user is the billing contact of this membership |
LsfrAccess
| LSFR Access | Boolean (Optional) | Specifies whether the user is permitted to access the LSFR on behalf of this membership |
Example Request
GET https://api.leaf.eco/r1/memberships/{membership}/contacts.eb HTTP/1.1
Accept: text/xml
Response Schema
<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="MembershipContacts">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="contacts" minOccurs="0">
<xsd:annotation>
<xsd:documentation>The list of users that are contacts for this membership</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="item" minOccurs="0" maxOccurs="unbounded">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="UserGUID" minOccurs="0" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The entity GUID of the user</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Name" minOccurs="0" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The name of the user</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="UserName" minOccurs="0" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The username of the user</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="EmailAddress" minOccurs="0" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The email address of the user</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="IsPrimaryContact" minOccurs="0" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>Specifies whether the user is the primary contact of this membership</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="IsBillingContact" minOccurs="0" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>Specifies whether the user is the billing contact of this membership</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="LsfrAccess" minOccurs="0" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>Specifies whether the user is permitted to access the LSFR on behalf of this membership</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
Example Response
HTTP/1.1 200 OK
Content-Type: text/xml
<?xml version="1.0" encoding="utf-8"?>
<MembershipContacts>
<contacts>
<item>
<UserGUID>xsd:string</UserGUID>
<Name>xsd:string</Name>
<UserName>xsd:string</UserName>
<EmailAddress>xsd:string</EmailAddress>
<IsPrimaryContact>xsd:boolean</IsPrimaryContact>
<IsBillingContact>xsd:boolean</IsBillingContact>
<LsfrAccess>xsd:boolean</LsfrAccess>
</item>...</contacts>
</MembershipContacts>
Example Request
GET https://api.leaf.eco/r1/memberships/{membership}/contacts.eb HTTP/1.1
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json
{"contacts":[{"UserGUID":String,
"Name":String,
"UserName":String,
"EmailAddress":String,
"IsPrimaryContact":Boolean,
"IsBillingContact":Boolean,
"LsfrAccess":Boolean},
...]}